home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / ttp23.zip / TIC2PCB.DOC < prev    next >
Text File  |  1993-01-22  |  24KB  |  540 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.      ▀▀▀▀█▀▀▀▀                  ▄▀▀▄            ▀█▀▀▀▀█ █▀▀▀▀█ ▀█▀▀▀▀█
  8.          █                     ▀    █            █    █ █       █    █
  9.          █   ▀ █▀▀▀▀              ▄▀             █▄▄▄▄█ █       █▄▄▄▄▀
  10.          █   █ █        ▀▀▀     ▄▀       ▀▀▀     █      █       █    █
  11.          █   █ █▄▄▄▄           █▄▄▄▄▄           ▄█▄     █▄▄▄▄█ ▄█▄▄▄▄█
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                Version 2.3
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                Copyright (C) 1992,93
  42.                                         by
  43.                                     Tom Carroll
  44.  
  45.  
  46.                                 All rights reserved
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.                                  The Data Shop BBS
  55.                             (509)582-9493 (16.8k HST/DS)
  56.                                    Kennewick, WA
  57.                               FIDO address (1:347/110)
  58.  
  59.                               MAGIC FILE NAME: TIC2PCB
  60.     ┌──────────────┐
  61.     │ INTRODUCTION │
  62.     └──────────────┘
  63.  
  64.     Tic-2-PCB was written because I wanted a program that would be very easy to
  65.     configure, and that would move the new files I get from time to time off the
  66.     FIDO SDN networks to my uploads directory.  I looked at the program called
  67.     TICK, but again, it was a program that required an extensive configuration
  68.     file, and it was very hard to understand the formatting of the directory
  69.     entries, hence, Tic-2-PCB was developed.
  70.  
  71.     ┌──────────────┐
  72.     │  DISCLAIMER  │
  73.     └──────────────┘
  74.  
  75.     This software is provided without any guarantee or warranty either expressed
  76.     or implied.  I will not be held responsible for ANY damages that may result
  77.     in the use of this program.  "ANY" means if you install it, run it, and it
  78.     eats your programs that you've been working on for 2 years without a backup,
  79.     IT'S NOT MY FAULT!!!
  80.  
  81.     Tic-2-PCB software and this document are Copyright (C) 1992, 93 by Tom
  82.     Carroll, All rights reserved.
  83.  
  84.     ┌──────────────┐
  85.     │   LICENSE    │
  86.     └──────────────┘
  87.  
  88.     This program is being released as FREEWARE.  The source code will remain
  89.     the property of the author unless otherwise released by him.
  90.  
  91.     You are free to use this version of the program without any cost of
  92.     registration.  This however, may change at any time with a new version
  93.     release. (If this should happen, a one time registration fee will be asked)
  94.  
  95.     No one may alter, modify, or reverse engineer Tic-2-PCB for any reason,
  96.     including but not limited to decompiling-compiling, patching, or
  97.     disassembling.
  98.  
  99.     You may freely distribute & copy this program for others subject to the
  100.     above restrictions and the following:
  101.  
  102.          ■ Tic-2-PCB is copied in unmodified form including this file.
  103.          ■ There is no charge for copying except for the cost of disks.
  104.          ■ Tic-2-PCB is not included in another software package without
  105.            the express written permission of Tom Carroll.
  106.  
  107.     ┌──────────────┐
  108.     │   SUPPORT    │
  109.     └──────────────┘
  110.  
  111.     If you should find any problems with this program, or you have any requests
  112.     or recommendations, you may reach me on my BBS, or at the FIDO address
  113.     listed on the front cover.  I may also be reached in the QUIK_BAS & PCBNET
  114.     FIDO echo's, UNI', ILink, and Global Link Sysop conferences, or on SaltAir.
  115.  
  116.     Tic-2-PCB Supports .TIC files from most file echo systems.
  117.  
  118.  
  119.     Tic-2-PCB v2.3                                                       Page 2
  120.     ┌──────────────┐
  121.     │  THE AUTHOR  │
  122.     └──────────────┘
  123.  
  124.     This was my first public program.
  125.  
  126.     I have been writing in BASIC for about 7 years, and I really like it, but 
  127.     I've been planning on taking a course in "C", but still haven't...
  128.  
  129.     I am presently active duty in the U.S. Coast Guard, and have been a "Sysop"
  130.     for their computer systems at my duty stations for about 6 years.
  131.  
  132.     I would like to thank my wife, who always says "Are you coming to bed, or
  133.     are you going to keep PLAYING on that computer?"
  134.  
  135.     ┌──────────────┐
  136.     │    FILES     │
  137.     └──────────────┘
  138.  
  139.     Files included in this archive:
  140.  
  141.               CONVERT.EXE  - Converts v2.2 config file to v2.3 binary format
  142.               FILE_ID.DIZ  - Description file for Tic-2-PCB
  143.               PROGRAMS.DWS - List of Dataware Software products
  144.               SAMPLE.LOG   - Sample log file
  145.               TIC2PCB.DOC  - This manual
  146.               TIC2PCB.HIS  - Tic-2-PCB's metamorphosis
  147.               TIC2PCB.EXE  - The heart of the game...
  148.               TTPCFG.EXE   - Tic-2-PCB Configuration editor
  149.  
  150.     I originally compressed this program as TTPnn.ARJ, but it may be
  151.     compressed with any other archive program you wish to use as long as all
  152.     the above listed files are included within the new archive.
  153.  
  154.     The latest version will always be available on my BBS using the magic
  155.     filename of TIC2PCB or in conference #1 (Dataware Support).
  156.  
  157.     Sometimes, there may be a need for debug code to be released.  This code is
  158.     used to track down specific problems which aren't normally encountered on
  159.     my system.  I have a 386/sx-25 w/4megs of RAM, a 386/40dx w/2megs of RAM,
  160.     and DOS 5.0, which should be pretty standard and generic, but sometimes this
  161.     doesn't present an optimal testing environment, so please, if you're having
  162.     problems, and debug code is available, feel free to FREQ TICDEBUG from me,
  163.     or if you're registered on my BBS call and download TIC2PCB.ARJ from
  164.     conference #1.  If it's not available, then you're the first person that has
  165.     reported a problem, so please leave me your specifics, and also your config
  166.     file so I may be able to trouble shoot the problem.
  167.  
  168.  
  169.     
  170.     
  171.     
  172.     Now, on with the installation...
  173.  
  174.  
  175.  
  176.  
  177.     
  178.     
  179.     Tic-2-PCB v2.3                                                       Page 3
  180.     ┌──────────────┐
  181.     │    SETUP     │
  182.     └──────────────┘
  183.  
  184.     First, if you're presently using version 2.2, you may use the included
  185.     CONVERT.EXE program to convert your old config file to the new binary
  186.     configuration file format.  The command line syntax is:
  187.  
  188.           CONVERT /TOLDCFG.FILE /BNEWCFG.FIL
  189.     
  190.     Now execute the included configuration program.  When the program
  191.     begins, if the specified configuration file doesn't exist, it will ask
  192.     you if it should create it.
  193.     
  194.     There will be five options from the main menu.  Here is an example of
  195.     what you should see:
  196.  
  197.                           ╔═════ Main Menu ═════╗
  198.                           ║                     ║
  199.                           ║ Default Information ║
  200.                           ║       Switches      ║
  201.                           ║   Area definitions  ║
  202.                           ║    Quit - No save   ║
  203.                           ║     Quit & Save     ║
  204.                           ║                     ║
  205.                           ╚═════════════════════╝
  206.  
  207.     You can use the arrow keys to select the option you want, and then press
  208.     <enter> to bring up the next menu.
  209.  
  210.     The defaults menu should look like this:
  211.  
  212.            ╔═ Defaults ═══════════════════════════════════════╗
  213.            ║     NodeNumber:                                  ║
  214.            ║        PCB.DAT:                                  ║
  215.            ║    Inbound DIR:                                  ║
  216.            ║    Default DOS:                                  ║
  217.            ║    Default PCB:                                  ║
  218.            ║   Default Msgs:                                  ║
  219.            ║   Download.Txt:                                  ║
  220.            ║      Test file:                                  ║
  221.            ╚══════════════════════════════════════════════════╝
  222.                             Press F1 for help
  223.  
  224.     The NodeNumber is the FIDO compliant node number that you will be
  225.     using.  This number will also be displayed in the message body if
  226.     you announce file arrivals.
  227.  
  228.     The PCB.DAT field is the location of your PCBOARD.DAT.  This is only
  229.     the path location of it, and not the file name.  PCBOARD.DAT is assumed.
  230.  
  231.     The Inbound DIR is where your incomming archives & .TIC files are stored
  232.     upon receipt.
  233.  
  234.     The Default DOS field is the location where you want UNKNOWN area files
  235.     imported (if you allow them).
  236.  
  237.  
  238.     
  239.     Tic-2-PCB v2.3                                                       Page 4
  240.     The Default PCB field is basically the same, but it will need to have
  241.     the full path and file name of the PCBoard(tm) directory listing.
  242.  
  243.     The Default Msgs field is where the file arrival announcement messages
  244.     will be placed for all UNKNOWN area files (if you allow UNKNOWN's).
  245.  
  246.     The Download.Txt entry requires the full path/name of your DOWNLOAD.TXT
  247.     file.  If this is left blank, the file will not be updated.
  248.  
  249.     Test file is the name of a batch file to be called after processing any
  250.     inbound files.  If you preceed this file name with an at '@' symbol
  251.     Tic-2-PCB will create a list file and pass it as parameter %1.
  252.  
  253.     To exit from this menu back to the main menu press <esc>.
  254.  
  255.                           ╔════════ Switches ════════╗
  256.                           ║ DIR File date: Current   ║
  257.                           ║   Import type: Move      ║
  258.                           ║    Duplicates: Overwrite ║
  259.                           ║    .TIC files: Kill      ║
  260.                           ║       Logging: On        ║
  261.                           ║  Rcvd by line: On        ║
  262.                           ║  Diz Checking: On        ║
  263.                           ║  CRC Checking: On        ║
  264.                           ║ Unknown Areas: On        ║
  265.                           ╚══════════════════════════╝
  266.  
  267.     These switches are setup as a default.  You may change them by pressing
  268.     <enter>.
  269.  
  270.     DIR File date - Current or Archive.  If set to Current the system date
  271.     will be used for the PCBoard(tm) directory listing, otherwise it will
  272.     use the archives file date stamp.
  273.  
  274.     Import type - Move or Copy.  If move is selected the archive will be
  275.     renamed to the destination directory.  If Copy is selected, then the
  276.     file will be copied which in turn would leave a copy in the inbound
  277.     directory too.
  278.     
  279.     Duplicates - Overwrite, Kill, or Hold.  This determines how duplicate
  280.     archives are handled.  If Overwrite is selected the older archive will
  281.     be overwritten using the newly arrived file.  If Kill is selected, then
  282.     the newly arrived archive will be deleted and not imported.  If hold is
  283.     chosen, then the .TIC file will be renamed to TKnnnnnn.DUP and the
  284.     archive will remain in the inbound directory.
  285.  
  286.     .TIC files - Keep or Kill.  Kill is recommended, but if you are
  287.     forwarding files to other systems, you may wish to use the Keep option.
  288.     If you use the Keep option, make sure the .TIC files are moved to another
  289.     directory before the next call to Tic-2-PCB. (The files will be renamed
  290.     to TKnnnnnn.xxx, depending on the errors encountered)
  291.  
  292.     Logging - Boolean.  Either ON or OFF.  TIC2PCB.ERR will still be created
  293.     should an error occur.
  294.  
  295.     Rcvd by line - Boolean.  Either ON or OFF.  Do you want the file
  296.     description appended with "Received by: Tic-2-PCB MM/DD/YY From:AREANAME
  297.  
  298.     
  299.     Tic-2-PCB v2.3                                                       Page 5
  300.     DIZ checking - Boolean.  Either ON or OFF.  If this is turned on, all new
  301.     archives will be checked for FILE_ID.DIZ & DESC.SDI files.
  302.  
  303.     CRC checking - Boolean.  Either ON or OFF.  If on, it will compare the
  304.     CRC-32 included in the .TIC file to the archives total CRC-32 value.  This
  305.     ensures no tampering has occured while in transit.
  306.  
  307.     Unknown Areas - Boolean.  Either ON or OFF.  If you turn this on, any files
  308.     received from an UNKNOWN (undeclared) area will be imported into the
  309.     default DOS & PCB directories, otherwise the accompanying .TIC file will be
  310.     renamed to TKnnnnnn.UNK and the archive will not be imported.
  311.  
  312.     ╔═ Areas ═════════════════════════════════════════════════════════════════╗
  313.     ║      1)              11)              21)              31)              ║
  314.     ║      2)              12)              22)              32)              ║
  315.     ║      3)              13)              23)              33)              ║
  316.     ║      4)              14)              24)              34)              ║
  317.     ║      5)              15)              25)              35)              ║
  318.     ║      6)              16)              26)              36)              ║
  319.     ║      7)              17)              27)              37)              ║
  320.     ║      8)              18)              28)              38)              ║
  321.     ║      9)              19)              29)              39)              ║
  322.     ║     10)              20)              30)              40)              ║
  323.     ╚═════════════════════════════════════════════════════════════════════════╝
  324.                             Press F1 for help
  325.  
  326.     Just select the area number to edit, and press <enter> to bring up the
  327.     area definitions menu, or press escape to return to the main menu.  If
  328.     you enter an area out of numerical order, the program will renumber it
  329.     to the next available number after the highest defined conference #.
  330.  
  331.            ╔═ Area definitions ═══════════════════════════════╗
  332.            ║      Area Name:                                  ║
  333.            ║  DOS Directory:                                  ║
  334.            ║   PCB DIR Name:                                  ║
  335.            ║  Area Password:                                  ║
  336.            ║   Message Base:                                  ║
  337.            ║   Send Msgs To:                                  ║
  338.            ║   Msg Security: N                                ║
  339.            ║      Echo Msgs: N                                ║
  340.            ╚══════════════════════════════════════════════════╝
  341.  
  342.     The area definitions menu will appear, and all you need to do is fill in
  343.     the information requsted.
  344.  
  345.     Area Name - This is the actual FIDO assigned area name for the file echo.
  346.     DOS Directory - This is the location the area files are tossed to.
  347.     PCB DIR Name - Is the name of the PCBoard directory to be updated with
  348.     description and file information.
  349.     Area Password - This is your assigned Raid password used on your hub.
  350.     Message Base - Location & name of the message base to send announcement
  351.     messages to.
  352.     Send Msgs To - The name of the individual that the messages will be
  353.     addressed to.
  354.     Msg Security - This is either set to "P" for private or "N" for none.
  355.     Echo Msgs - Boolean.  Either YES or NO.
  356.  
  357.     
  358.     
  359.     Tic-2-PCB v2.3                                                       Page 6
  360.     After filling out the form, you can press <esc> to exit back to the
  361.     Areas menu.
  362.  
  363.     ┌──────────────┐
  364.     │  OPERATION   │
  365.     └──────────────┘
  366.  
  367.     Now, all you need to do is execute TIC2PCB.EXE and give it the config file
  368.     name.  (i.e.  TIC2PCB MYCONFIG.CFG)  Also, there are two command line
  369.     switches that may be used by Tic-2-PCB.  /BELL and /M.  /BELL will turn
  370.     off the bell when an error is encountered.  /M will force Tic-2-PCB's
  371.     output routines into Monochrome mode.
  372.  
  373.     If a file is specified for the DOWNLOAD.TXT file, Tic-2-PCB will update it
  374.     with the following entry:
  375.  
  376.     (U),TIC-2-PCB AREANAME,MM-DD-YYYY,HH:MM,FILENAME.EXT,L,0,9600
  377.     
  378.     This entry just tells your File Profilers that an upload by Tic-2-PCB of
  379.     a file from AREANAME on that date & time consisted of FILENAME.EXT, using
  380.     the L protocol (I used the L protocol to signify a local upload) with no
  381.     errors, with an average speed of 9600 CPS.
  382.  
  383.     There will be one log file created if it doesn't exist (should you not
  384.     disable that option) called TIC2PCB.LOG.  It will be in the following
  385.     format:
  386.     
  387.              --------[ Processing {INBOUND} - MM-DD-YYYY - HH:MM:SS
  388.              --------[ Process complete - MM-DD-YYYY - HH:MM:SS
  389.              --------[ Process Aborted! - MM-DD-YYYY - HH:MM:SS
  390.              A - Area unknown for file specified
  391.                  Renamed .TIC to .UNK
  392.              C - CRC check sum error on archive
  393.                  Renamed .TIC to .CRC
  394.              D - FILE_ID.DIZ is longer than 450 bytes - Not used
  395.              E - Error encountered in .TIC file
  396.                  Renamed .TIC to .ERR
  397.              F - File doesn't exist
  398.                  Renamed .TIC to .FIL
  399.              P - Incorrect password for AREA
  400.                  Renamed .TIC to .PWD
  401.              S - DESC.SDI longer than 85 bytes - Not used
  402.              X - A duplicate file was encountered
  403.                  <action taken> (either renamed .TIC to .DUP, killed, or
  404.                  overwrote)
  405.              √ - Process successful.  File imported properly
  406.  
  407.     I recommend deleting this file, or not using it at all if you move or
  408.     receive a lot of files through FIDO.  In any case, should you use it, be
  409.     sure to check the size of it every now and then.  If you don't want the
  410.     logging, just select Logging Off in config file Switches menu.
  411.  
  412.     When Tic-2-PCB has executed successfully, it will exit with an errorlevel
  413.     set to 0.  If an error is encountered during execution, it will exit with
  414.     an errorlevel of 1, and create a file called TIC2PCB.ERR.  If it should
  415.     encounter an unexpected error, it will exit with an errorlevel set to 2.
  416.  
  417.     
  418.     
  419.     Tic-2-PCB v2.3                                                       Page 7
  420.     When a file is received that isn't in any of your AREA declarations, and
  421.     you have the UNKNOWN keyword in the config file it will be imported into
  422.     the default directory and DIR file listed in lines Default DOS & Default
  423.     PCB within the Defaults section of the config program.  The "Received by:
  424.     Tic-2-PCB xx-xx-xx from AREANAME" in the default DIR listing will show the
  425.     area it was actually received from.
  426.     
  427.     Here is an excerpt of my RUN.BAT file which shows how I process my tick
  428.     files:
  429.  
  430.     CD \FD
  431.     REM           ---------  CHECK FOR NEW FILES    ---------
  432.     IF TIC2PCB TIC2PCB.CFG <options>
  433.  
  434.     That's it, you shouldn't have to do anything else, but fire it up and see
  435.     how easy and quick it actually is.
  436.  
  437.     ┌──────────────┐
  438.     │    NOTES     │
  439.     └──────────────┘
  440.  
  441.     Please remember that the speed factor will be reduced if you have logging,
  442.     check for DIZ, or check CRC-32 turned on, otherwise Tic-2-PCB will import
  443.     approximately 1.5 files per second if it is only moving the archives from
  444.     one directory to another on the same drive.
  445.     
  446.     You may find several TICK files within your inbound directory with the
  447.     following extensions:
  448.  
  449.          TKnnnnnn.DUP - A duplicate file was encountered in the destination
  450.                         import directory.  You have the Duplicates switch
  451.                         set to hold, so the .TIC file was renamed to .DUP
  452.                         and the archive was not imported.  This is an
  453.                         oportunity to check the .TIC files path & seen-by
  454.                         lines to determine where the break down is that is
  455.                         causing duplicates to loop back through the system.
  456.  
  457.          TKnnnnnn.ERR - An error was encountered within the .TIC file.
  458.                         This will be caused by trashed files, or a non-
  459.                         standard format for the .TIC file.  The archive
  460.                         is NOT processed into the system.  Please notify
  461.                         me if you have these appear on your system.
  462.  
  463.          TKnnnnnn.FIL - The listed archive within the .TIC file doesn't exist.
  464.                         This could be the cause of another file processor 
  465.                         moving/deleting the archive before Tic-2-PCB processed
  466.                         it into the system, or you have the KEEPTIC option
  467.                         turned on in your config file and Tic-2-PCB is re-
  468.                         processing the .TIC files.
  469.  
  470.          TKnnnnnn.PWD - An incorrect password was encountered within the .TIC
  471.                         file.  The archive was not processed into the system.
  472.                         This could be caused by an incorrect password listed
  473.                         within the config file for the AREA name, or you have
  474.                         changed your RAID password on your host node.
  475.  
  476.  
  477.     
  478.     
  479.     Tic-2-PCB v2.3                                                       Page 8
  480.          TKnnnnnn.CRC - An invalid check sum was found in the .TIC file for
  481.                         the listed archive.  The archive was not processed
  482.                         into the system.  This will be caused by someone
  483.                         changing the archive format, or tampering with the
  484.                         original archive release.
  485.  
  486.          TKnnnnnn.UNK - An unknown AREA was found in the .TIC file for the
  487.                         listed archive.  The archive was not processed into
  488.                         the system.  This will be caused by receiving a new
  489.                         file echo and not having an AREA definition for it, 
  490.                         or not having the UNKNOWN option turned on in the
  491.                         config file.
  492.     ┌──────────────┐
  493.     │  DONATIONS   │
  494.     └──────────────┘
  495.  
  496.     This version of software is free for the taking, but if you feel compelled
  497.     to make a donation, you may send whatever contribution that you feel is
  498.     reasonable to the following address:   
  499.                                            Dataware Software
  500.                                            1922 W. 4th Avenue
  501.                                            Kennewick, WA  99336
  502.     
  503.     I will be transferring in the spring or summer of 1993.  If you call my
  504.     BBS and do not get an answer, you may leave me mail in one of the networks
  505.     listed above, or contact one of the following three BBS's for a tech
  506.     support account.
  507.     
  508.                    The One Stop PCBoard       Arid Acres
  509.                        Gary Hedberg           John Allen
  510.                       (509)943-0211        (509)544-0113/14
  511.                         (v.32bis)               (v.32)
  512.     
  513.     ┌────────────────┐
  514.     │ACKNOWLEDGEMENTS│
  515.     └────────────────┘
  516.     
  517.     I would like to thank the Tic-2-PCB beta test team.  Without their
  518.     help, this version would not have made it out the door with the quality
  519.     of work that is expected of Dataware Software.
  520.  
  521.     If you see these guys around take a moment to thank them for assisting
  522.     me in the production of a nice utility that ALL PCBoard(tm) sysops may
  523.     use and enjoy!
  524.     
  525.     Fred "Buz" Busteed      The Arcs and Sparks BBS
  526.     Fran To                 Orient Express
  527.     Gary Hedberg            The One Stop PCBoard
  528.     Larry Short             The Computer Gallery
  529.     
  530.     
  531.     
  532.     
  533.     
  534.     
  535.     
  536.     
  537.     
  538.     
  539.     Tic-2-PCB v2.3                                                       Page 9
  540.